<?php

/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
namespace VendorDuplicator\Google\Service\Drive\Resource;

use VendorDuplicator\Google\Service\Drive\Permission;
use VendorDuplicator\Google\Service\Drive\PermissionList;
/**
 * The "permissions" collection of methods.
 * Typical usage is:
 *  <code>
 *   $driveService = new Google\Service\Drive(...);
 *   $permissions = $driveService->permissions;
 *  </code>
 */
class Permissions extends \VendorDuplicator\Google\Service\Resource
{
    /**
     * Creates a permission for a file or shared drive. For more information on
     * creating permissions, see Share files, folders & drives. (permissions.create)
     *
     * @param string $fileId The ID of the file or shared drive.
     * @param Permission $postBody
     * @param array $optParams Optional parameters.
     *
     * @opt_param string emailMessage A plain text custom message to include in the
     * notification email.
     * @opt_param bool enforceSingleParent Deprecated. See moveToNewOwnersRoot for
     * details.
     * @opt_param bool moveToNewOwnersRoot This parameter will only take effect if
     * the item is not in a shared drive and the request is attempting to transfer
     * the ownership of the item. If set to true, the item will be moved to the new
     * owner's My Drive root folder and all prior parents removed. If set to false,
     * parents are not changed.
     * @opt_param bool sendNotificationEmail Whether to send a notification email
     * when sharing to users or groups. This defaults to true for users and groups,
     * and is not allowed for other requests. It must not be disabled for ownership
     * transfers.
     * @opt_param bool supportsAllDrives Whether the requesting application supports
     * both My Drives and shared drives.
     * @opt_param bool supportsTeamDrives Deprecated use supportsAllDrives instead.
     * @opt_param bool transferOwnership Whether to transfer ownership to the
     * specified user and downgrade the current owner to a writer. This parameter is
     * required as an acknowledgement of the side effect. File owners can only
     * transfer ownership of files existing on My Drive. Files existing in a shared
     * drive are owned by the organization that owns that shared drive. Ownership
     * transfers are not supported for files and folders in shared drives.
     * Organizers of a shared drive can move items from that shared drive into their
     * My Drive which transfers the ownership to them.
     * @opt_param bool useDomainAdminAccess Issue the request as a domain
     * administrator; if set to true, then the requester will be granted access if
     * the file ID parameter refers to a shared drive and the requester is an
     * administrator of the domain to which the shared drive belongs.
     * @return Permission
     */
    public function create($fileId, Permission $postBody, $optParams = [])
    {
        $params = ['fileId' => $fileId, 'postBody' => $postBody];
        $params = \array_merge($params, $optParams);
        return $this->call('create', [$params], Permission::class);
    }
    /**
     * Deletes a permission. (permissions.delete)
     *
     * @param string $fileId The ID of the file or shared drive.
     * @param string $permissionId The ID of the permission.
     * @param array $optParams Optional parameters.
     *
     * @opt_param bool supportsAllDrives Whether the requesting application supports
     * both My Drives and shared drives.
     * @opt_param bool supportsTeamDrives Deprecated use supportsAllDrives instead.
     * @opt_param bool useDomainAdminAccess Issue the request as a domain
     * administrator; if set to true, then the requester will be granted access if
     * the file ID parameter refers to a shared drive and the requester is an
     * administrator of the domain to which the shared drive belongs.
     */
    public function delete($fileId, $permissionId, $optParams = [])
    {
        $params = ['fileId' => $fileId, 'permissionId' => $permissionId];
        $params = \array_merge($params, $optParams);
        return $this->call('delete', [$params]);
    }
    /**
     * Gets a permission by ID. (permissions.get)
     *
     * @param string $fileId The ID of the file.
     * @param string $permissionId The ID of the permission.
     * @param array $optParams Optional parameters.
     *
     * @opt_param bool supportsAllDrives Whether the requesting application supports
     * both My Drives and shared drives.
     * @opt_param bool supportsTeamDrives Deprecated use supportsAllDrives instead.
     * @opt_param bool useDomainAdminAccess Issue the request as a domain
     * administrator; if set to true, then the requester will be granted access if
     * the file ID parameter refers to a shared drive and the requester is an
     * administrator of the domain to which the shared drive belongs.
     * @return Permission
     */
    public function get($fileId, $permissionId, $optParams = [])
    {
        $params = ['fileId' => $fileId, 'permissionId' => $permissionId];
        $params = \array_merge($params, $optParams);
        return $this->call('get', [$params], Permission::class);
    }
    /**
     * Lists a file's or shared drive's permissions. (permissions.listPermissions)
     *
     * @param string $fileId The ID of the file or shared drive.
     * @param array $optParams Optional parameters.
     *
     * @opt_param string includePermissionsForView Specifies which additional view's
     * permissions to include in the response. Only 'published' is supported.
     * @opt_param int pageSize The maximum number of permissions to return per page.
     * When not set for files in a shared drive, at most 100 results will be
     * returned. When not set for files that are not in a shared drive, the entire
     * list will be returned.
     * @opt_param string pageToken The token for continuing a previous list request
     * on the next page. This should be set to the value of 'nextPageToken' from the
     * previous response.
     * @opt_param bool supportsAllDrives Whether the requesting application supports
     * both My Drives and shared drives.
     * @opt_param bool supportsTeamDrives Deprecated use supportsAllDrives instead.
     * @opt_param bool useDomainAdminAccess Issue the request as a domain
     * administrator; if set to true, then the requester will be granted access if
     * the file ID parameter refers to a shared drive and the requester is an
     * administrator of the domain to which the shared drive belongs.
     * @return PermissionList
     */
    public function listPermissions($fileId, $optParams = [])
    {
        $params = ['fileId' => $fileId];
        $params = \array_merge($params, $optParams);
        return $this->call('list', [$params], PermissionList::class);
    }
    /**
     * Updates a permission with patch semantics. (permissions.update)
     *
     * @param string $fileId The ID of the file or shared drive.
     * @param string $permissionId The ID of the permission.
     * @param Permission $postBody
     * @param array $optParams Optional parameters.
     *
     * @opt_param bool removeExpiration Whether to remove the expiration date.
     * @opt_param bool supportsAllDrives Whether the requesting application supports
     * both My Drives and shared drives.
     * @opt_param bool supportsTeamDrives Deprecated use supportsAllDrives instead.
     * @opt_param bool transferOwnership Whether to transfer ownership to the
     * specified user and downgrade the current owner to a writer. This parameter is
     * required as an acknowledgement of the side effect. File owners can only
     * transfer ownership of files existing on My Drive. Files existing in a shared
     * drive are owned by the organization that owns that shared drive. Ownership
     * transfers are not supported for files and folders in shared drives.
     * Organizers of a shared drive can move items from that shared drive into their
     * My Drive which transfers the ownership to them.
     * @opt_param bool useDomainAdminAccess Issue the request as a domain
     * administrator; if set to true, then the requester will be granted access if
     * the file ID parameter refers to a shared drive and the requester is an
     * administrator of the domain to which the shared drive belongs.
     * @return Permission
     */
    public function update($fileId, $permissionId, Permission $postBody, $optParams = [])
    {
        $params = ['fileId' => $fileId, 'permissionId' => $permissionId, 'postBody' => $postBody];
        $params = \array_merge($params, $optParams);
        return $this->call('update', [$params], Permission::class);
    }
}
// Adding a class alias for backwards compatibility with the previous class name.
\class_alias(Permissions::class, 'VendorDuplicator\\Google_Service_Drive_Resource_Permissions');
